Member functions¶
- class CHAOS\Portal\Client\PortalClient¶
- PortalClient:: CLIENT_VERSION = "1.1.1";
- PortalClient:: PROTOCOL_VERSION = 4;
- PortalClient:: FORMAT = "json";
- PortalClient:: USE_HTTP_STATUS_CODES = false;
- ClientVersion()¶
Returns the version of the client.
Returns: string
- ProtocolVersion()¶
Returns the protocol version used by the client.
Returns: int
- SetSessionGUID()¶
Sets a session GUID to use.
Parameters: - $guid (string) – The GUID to use.
- $isAuthenticated (bool) – True if the GUID is authenticated.
- SessionGUID()¶
Returns the currently used session GUID.
Returns: string
- HasSession()¶
Returns true if the PortalClient instance has a session.
Returns: bool
- ClientGUID()¶
Returns the client GUID.
Returns: string
- __construct()¶
Parameters: - $servicePath (String) – The URL of the Portal service.
- $clientGUID (String) – The GUID by which the client is identified.
- $autoCreateSession (Bool) – If true a session will be created in the constructor call.
- __destruct()¶
- CallService()¶
- Session()¶
Returns: \CHAOS\Portal\Client\Extensions\ISessionExtension
- ClientSettings()¶
Returns: \CHAOS\Portal\Client\Extensions\IClientSettingsExtension
- UserSettings()¶
Returns: \CHAOS\Portal\Client\Extensions\IUserSEttingsExtension
- EmailPassword()¶
Returns: \CHAOS\Portal\Client\Extensions\IEmailPasswordExtension
- SecureCooke()¶
Returns: \CHAOS\Portal\Client\Extensions\ISecureCookieExtension
- Object()¶
Returns: \CHAOS\Portal\Client\Extensions\IObjectExtension
- ObjectRelation()¶
Returns: \CHAOS\Portal\Client\Extensions\IObjectRelationExtension
- ObjectType()¶
Returns: \CHAOS\Portal\Client\Extensions\IObjectTypeExtension
- File()¶
Returns: \CHAOS\Portal\Client\Extensions\IFileExtension
- Folder()¶
Returns: \CHAOS\Portal\Client\Extensions\IFolderExtension
- FolderType()¶
Returns: \CHAOS\Portal\Client\Extensions\IFolderTypeExtension
- Format()¶
Returns: \CHAOS\Portal\Client\Extensions\IFormatExtension
- Language()¶
Returns: \CHAOS\Portal\Client\Extensions\ILanguageExtension
- Link()¶
Returns: \CHAOS\Portal\Client\Extensions\ILinkExtension
- Metadata()¶
Returns: \CHAOS\Portal\Client\Extensions\IMetadataExtension
- MetadataSchema()¶
Returns: \CHAOS\Portal\Client\Extensions\IMetadataSchemaExtension
- ObjectRelationType()¶
Returns: \CHAOS\Portal\Client\Extensions\IObjectRelationTypeExtension
- StatsObject()¶
Returns: \CHAOS\Portal\Client\Extensions\IStatsObjectExtension
- Upload()¶
Returns: \CHAOS\Portal\Client\Extensions\IUploadExtension